<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="merchantapi_accounts_v1.html">Merchant API</a> . <a href="merchantapi_accounts_v1.accounts.html">accounts</a> . <a href="merchantapi_accounts_v1.accounts.programs.html">programs</a> . <a href="merchantapi_accounts_v1.accounts.programs.checkoutSettings.html">checkoutSettings</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates `CheckoutSettings` for the given merchant.</p>
<p class="toc_element">
  <code><a href="#deleteCheckoutSettings">deleteCheckoutSettings(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes `CheckoutSettings` and unenrolls merchant from `Checkout` program.</p>
<p class="toc_element">
  <code><a href="#getCheckoutSettings">getCheckoutSettings(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets `CheckoutSettings` for the given merchant. This includes information about review state, enrollment state and URL settings.</p>
<p class="toc_element">
  <code><a href="#updateCheckoutSettings">updateCheckoutSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates `CheckoutSettings` for the given merchant.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
  <pre>Creates `CheckoutSettings` for the given merchant.

Args:
  parent: string, Required. The merchant account for which the `CheckoutSettings` will be created. (required)
  body: object, The request body.
    The object takes the form of:

{ # [CheckoutSettings](https://support.google.com/merchants/answer/13945960) for a specific merchant.
  &quot;effectiveEnrollmentState&quot;: &quot;A String&quot;, # Output only. The effective value of enrollment_state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account (for only marketplace sellers).
  &quot;effectiveReviewState&quot;: &quot;A String&quot;, # Output only. The effective value of `review_state` for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account (for only marketplace sellers).
  &quot;effectiveUriSettings&quot;: { # URL settings for cart or checkout URL. # Output only. The effective value of `uri_settings` for a given merchant. If account level settings are present then this value will be a copy of url settings. Otherwise, it will have the value of the parent account (for only marketplace sellers).
    &quot;cartUriTemplate&quot;: &quot;A String&quot;, # Cart URL template. When the placeholders are expanded will redirect the buyer to the cart page on the merchant website with the selected item in cart. For more details, check the [help center doc](https://support.google.com/merchants/answer/13945960#method1&amp;zippy=%2Cproduct-level-url-formatting%2Caccount-level-url-formatting)
    &quot;checkoutUriTemplate&quot;: &quot;A String&quot;, # Checkout URL template. When the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart. For more details, check the [help center doc](https://support.google.com/merchants/answer/13945960#method1&amp;zippy=%2Cproduct-level-url-formatting%2Caccount-level-url-formatting)
  },
  &quot;eligibleDestinations&quot;: [ # Optional. The destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) to which the checkout program applies, valid destination values are `SHOPPING_ADS`, `FREE_LISTINGS`
    &quot;A String&quot;,
  ],
  &quot;enrollmentState&quot;: &quot;A String&quot;, # Output only. Reflects the merchant enrollment state in `Checkout` program.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the program configuration settings. Format: `accounts/{account}/programs/{program}/checkoutSettings`
  &quot;reviewState&quot;: &quot;A String&quot;, # Output only. Reflects the merchant review state in `Checkout` program. This is set based on the data quality reviews of the URL provided by the merchant. A merchant with enrollment state as `ENROLLED` can be in the following review states: `IN_REVIEW`, `APPROVED` or `DISAPPROVED`. A merchant must be in an `enrollment_state` of `ENROLLED` before a review can begin for the merchant.For more details, check the help center doc.
  &quot;uriSettings&quot;: { # URL settings for cart or checkout URL. # URI settings for cart or checkout URL.
    &quot;cartUriTemplate&quot;: &quot;A String&quot;, # Cart URL template. When the placeholders are expanded will redirect the buyer to the cart page on the merchant website with the selected item in cart. For more details, check the [help center doc](https://support.google.com/merchants/answer/13945960#method1&amp;zippy=%2Cproduct-level-url-formatting%2Caccount-level-url-formatting)
    &quot;checkoutUriTemplate&quot;: &quot;A String&quot;, # Checkout URL template. When the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart. For more details, check the [help center doc](https://support.google.com/merchants/answer/13945960#method1&amp;zippy=%2Cproduct-level-url-formatting%2Caccount-level-url-formatting)
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # [CheckoutSettings](https://support.google.com/merchants/answer/13945960) for a specific merchant.
  &quot;effectiveEnrollmentState&quot;: &quot;A String&quot;, # Output only. The effective value of enrollment_state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account (for only marketplace sellers).
  &quot;effectiveReviewState&quot;: &quot;A String&quot;, # Output only. The effective value of `review_state` for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account (for only marketplace sellers).
  &quot;effectiveUriSettings&quot;: { # URL settings for cart or checkout URL. # Output only. The effective value of `uri_settings` for a given merchant. If account level settings are present then this value will be a copy of url settings. Otherwise, it will have the value of the parent account (for only marketplace sellers).
    &quot;cartUriTemplate&quot;: &quot;A String&quot;, # Cart URL template. When the placeholders are expanded will redirect the buyer to the cart page on the merchant website with the selected item in cart. For more details, check the [help center doc](https://support.google.com/merchants/answer/13945960#method1&amp;zippy=%2Cproduct-level-url-formatting%2Caccount-level-url-formatting)
    &quot;checkoutUriTemplate&quot;: &quot;A String&quot;, # Checkout URL template. When the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart. For more details, check the [help center doc](https://support.google.com/merchants/answer/13945960#method1&amp;zippy=%2Cproduct-level-url-formatting%2Caccount-level-url-formatting)
  },
  &quot;eligibleDestinations&quot;: [ # Optional. The destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) to which the checkout program applies, valid destination values are `SHOPPING_ADS`, `FREE_LISTINGS`
    &quot;A String&quot;,
  ],
  &quot;enrollmentState&quot;: &quot;A String&quot;, # Output only. Reflects the merchant enrollment state in `Checkout` program.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the program configuration settings. Format: `accounts/{account}/programs/{program}/checkoutSettings`
  &quot;reviewState&quot;: &quot;A String&quot;, # Output only. Reflects the merchant review state in `Checkout` program. This is set based on the data quality reviews of the URL provided by the merchant. A merchant with enrollment state as `ENROLLED` can be in the following review states: `IN_REVIEW`, `APPROVED` or `DISAPPROVED`. A merchant must be in an `enrollment_state` of `ENROLLED` before a review can begin for the merchant.For more details, check the help center doc.
  &quot;uriSettings&quot;: { # URL settings for cart or checkout URL. # URI settings for cart or checkout URL.
    &quot;cartUriTemplate&quot;: &quot;A String&quot;, # Cart URL template. When the placeholders are expanded will redirect the buyer to the cart page on the merchant website with the selected item in cart. For more details, check the [help center doc](https://support.google.com/merchants/answer/13945960#method1&amp;zippy=%2Cproduct-level-url-formatting%2Caccount-level-url-formatting)
    &quot;checkoutUriTemplate&quot;: &quot;A String&quot;, # Checkout URL template. When the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart. For more details, check the [help center doc](https://support.google.com/merchants/answer/13945960#method1&amp;zippy=%2Cproduct-level-url-formatting%2Caccount-level-url-formatting)
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="deleteCheckoutSettings">deleteCheckoutSettings(name, x__xgafv=None)</code>
  <pre>Deletes `CheckoutSettings` and unenrolls merchant from `Checkout` program.

Args:
  name: string, Required. The name/identifier of the merchant account. Format: `accounts/{account}/programs/{program}/checkoutSettings` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>

<div class="method">
    <code class="details" id="getCheckoutSettings">getCheckoutSettings(name, x__xgafv=None)</code>
  <pre>Gets `CheckoutSettings` for the given merchant. This includes information about review state, enrollment state and URL settings.

Args:
  name: string, Required. The name/identifier of the merchant account. Format: `accounts/{account}/programs/{program}/checkoutSettings` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # [CheckoutSettings](https://support.google.com/merchants/answer/13945960) for a specific merchant.
  &quot;effectiveEnrollmentState&quot;: &quot;A String&quot;, # Output only. The effective value of enrollment_state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account (for only marketplace sellers).
  &quot;effectiveReviewState&quot;: &quot;A String&quot;, # Output only. The effective value of `review_state` for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account (for only marketplace sellers).
  &quot;effectiveUriSettings&quot;: { # URL settings for cart or checkout URL. # Output only. The effective value of `uri_settings` for a given merchant. If account level settings are present then this value will be a copy of url settings. Otherwise, it will have the value of the parent account (for only marketplace sellers).
    &quot;cartUriTemplate&quot;: &quot;A String&quot;, # Cart URL template. When the placeholders are expanded will redirect the buyer to the cart page on the merchant website with the selected item in cart. For more details, check the [help center doc](https://support.google.com/merchants/answer/13945960#method1&amp;zippy=%2Cproduct-level-url-formatting%2Caccount-level-url-formatting)
    &quot;checkoutUriTemplate&quot;: &quot;A String&quot;, # Checkout URL template. When the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart. For more details, check the [help center doc](https://support.google.com/merchants/answer/13945960#method1&amp;zippy=%2Cproduct-level-url-formatting%2Caccount-level-url-formatting)
  },
  &quot;eligibleDestinations&quot;: [ # Optional. The destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) to which the checkout program applies, valid destination values are `SHOPPING_ADS`, `FREE_LISTINGS`
    &quot;A String&quot;,
  ],
  &quot;enrollmentState&quot;: &quot;A String&quot;, # Output only. Reflects the merchant enrollment state in `Checkout` program.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the program configuration settings. Format: `accounts/{account}/programs/{program}/checkoutSettings`
  &quot;reviewState&quot;: &quot;A String&quot;, # Output only. Reflects the merchant review state in `Checkout` program. This is set based on the data quality reviews of the URL provided by the merchant. A merchant with enrollment state as `ENROLLED` can be in the following review states: `IN_REVIEW`, `APPROVED` or `DISAPPROVED`. A merchant must be in an `enrollment_state` of `ENROLLED` before a review can begin for the merchant.For more details, check the help center doc.
  &quot;uriSettings&quot;: { # URL settings for cart or checkout URL. # URI settings for cart or checkout URL.
    &quot;cartUriTemplate&quot;: &quot;A String&quot;, # Cart URL template. When the placeholders are expanded will redirect the buyer to the cart page on the merchant website with the selected item in cart. For more details, check the [help center doc](https://support.google.com/merchants/answer/13945960#method1&amp;zippy=%2Cproduct-level-url-formatting%2Caccount-level-url-formatting)
    &quot;checkoutUriTemplate&quot;: &quot;A String&quot;, # Checkout URL template. When the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart. For more details, check the [help center doc](https://support.google.com/merchants/answer/13945960#method1&amp;zippy=%2Cproduct-level-url-formatting%2Caccount-level-url-formatting)
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="updateCheckoutSettings">updateCheckoutSettings(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates `CheckoutSettings` for the given merchant.

Args:
  name: string, Identifier. The resource name of the program configuration settings. Format: `accounts/{account}/programs/{program}/checkoutSettings` (required)
  body: object, The request body.
    The object takes the form of:

{ # [CheckoutSettings](https://support.google.com/merchants/answer/13945960) for a specific merchant.
  &quot;effectiveEnrollmentState&quot;: &quot;A String&quot;, # Output only. The effective value of enrollment_state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account (for only marketplace sellers).
  &quot;effectiveReviewState&quot;: &quot;A String&quot;, # Output only. The effective value of `review_state` for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account (for only marketplace sellers).
  &quot;effectiveUriSettings&quot;: { # URL settings for cart or checkout URL. # Output only. The effective value of `uri_settings` for a given merchant. If account level settings are present then this value will be a copy of url settings. Otherwise, it will have the value of the parent account (for only marketplace sellers).
    &quot;cartUriTemplate&quot;: &quot;A String&quot;, # Cart URL template. When the placeholders are expanded will redirect the buyer to the cart page on the merchant website with the selected item in cart. For more details, check the [help center doc](https://support.google.com/merchants/answer/13945960#method1&amp;zippy=%2Cproduct-level-url-formatting%2Caccount-level-url-formatting)
    &quot;checkoutUriTemplate&quot;: &quot;A String&quot;, # Checkout URL template. When the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart. For more details, check the [help center doc](https://support.google.com/merchants/answer/13945960#method1&amp;zippy=%2Cproduct-level-url-formatting%2Caccount-level-url-formatting)
  },
  &quot;eligibleDestinations&quot;: [ # Optional. The destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) to which the checkout program applies, valid destination values are `SHOPPING_ADS`, `FREE_LISTINGS`
    &quot;A String&quot;,
  ],
  &quot;enrollmentState&quot;: &quot;A String&quot;, # Output only. Reflects the merchant enrollment state in `Checkout` program.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the program configuration settings. Format: `accounts/{account}/programs/{program}/checkoutSettings`
  &quot;reviewState&quot;: &quot;A String&quot;, # Output only. Reflects the merchant review state in `Checkout` program. This is set based on the data quality reviews of the URL provided by the merchant. A merchant with enrollment state as `ENROLLED` can be in the following review states: `IN_REVIEW`, `APPROVED` or `DISAPPROVED`. A merchant must be in an `enrollment_state` of `ENROLLED` before a review can begin for the merchant.For more details, check the help center doc.
  &quot;uriSettings&quot;: { # URL settings for cart or checkout URL. # URI settings for cart or checkout URL.
    &quot;cartUriTemplate&quot;: &quot;A String&quot;, # Cart URL template. When the placeholders are expanded will redirect the buyer to the cart page on the merchant website with the selected item in cart. For more details, check the [help center doc](https://support.google.com/merchants/answer/13945960#method1&amp;zippy=%2Cproduct-level-url-formatting%2Caccount-level-url-formatting)
    &quot;checkoutUriTemplate&quot;: &quot;A String&quot;, # Checkout URL template. When the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart. For more details, check the [help center doc](https://support.google.com/merchants/answer/13945960#method1&amp;zippy=%2Cproduct-level-url-formatting%2Caccount-level-url-formatting)
  },
}

  updateMask: string, Required. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `eligible_destinations` - `uri_settings`
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # [CheckoutSettings](https://support.google.com/merchants/answer/13945960) for a specific merchant.
  &quot;effectiveEnrollmentState&quot;: &quot;A String&quot;, # Output only. The effective value of enrollment_state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account (for only marketplace sellers).
  &quot;effectiveReviewState&quot;: &quot;A String&quot;, # Output only. The effective value of `review_state` for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account (for only marketplace sellers).
  &quot;effectiveUriSettings&quot;: { # URL settings for cart or checkout URL. # Output only. The effective value of `uri_settings` for a given merchant. If account level settings are present then this value will be a copy of url settings. Otherwise, it will have the value of the parent account (for only marketplace sellers).
    &quot;cartUriTemplate&quot;: &quot;A String&quot;, # Cart URL template. When the placeholders are expanded will redirect the buyer to the cart page on the merchant website with the selected item in cart. For more details, check the [help center doc](https://support.google.com/merchants/answer/13945960#method1&amp;zippy=%2Cproduct-level-url-formatting%2Caccount-level-url-formatting)
    &quot;checkoutUriTemplate&quot;: &quot;A String&quot;, # Checkout URL template. When the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart. For more details, check the [help center doc](https://support.google.com/merchants/answer/13945960#method1&amp;zippy=%2Cproduct-level-url-formatting%2Caccount-level-url-formatting)
  },
  &quot;eligibleDestinations&quot;: [ # Optional. The destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) to which the checkout program applies, valid destination values are `SHOPPING_ADS`, `FREE_LISTINGS`
    &quot;A String&quot;,
  ],
  &quot;enrollmentState&quot;: &quot;A String&quot;, # Output only. Reflects the merchant enrollment state in `Checkout` program.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the program configuration settings. Format: `accounts/{account}/programs/{program}/checkoutSettings`
  &quot;reviewState&quot;: &quot;A String&quot;, # Output only. Reflects the merchant review state in `Checkout` program. This is set based on the data quality reviews of the URL provided by the merchant. A merchant with enrollment state as `ENROLLED` can be in the following review states: `IN_REVIEW`, `APPROVED` or `DISAPPROVED`. A merchant must be in an `enrollment_state` of `ENROLLED` before a review can begin for the merchant.For more details, check the help center doc.
  &quot;uriSettings&quot;: { # URL settings for cart or checkout URL. # URI settings for cart or checkout URL.
    &quot;cartUriTemplate&quot;: &quot;A String&quot;, # Cart URL template. When the placeholders are expanded will redirect the buyer to the cart page on the merchant website with the selected item in cart. For more details, check the [help center doc](https://support.google.com/merchants/answer/13945960#method1&amp;zippy=%2Cproduct-level-url-formatting%2Caccount-level-url-formatting)
    &quot;checkoutUriTemplate&quot;: &quot;A String&quot;, # Checkout URL template. When the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart. For more details, check the [help center doc](https://support.google.com/merchants/answer/13945960#method1&amp;zippy=%2Cproduct-level-url-formatting%2Caccount-level-url-formatting)
  },
}</pre>
</div>

</body></html>